Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

ExtPageGenerator

Scoped name

WSYEXTJS/ExtPageGenerator

Note that this abstract function is placed in the WSYEXTJS model.

Purpose

This is the base PageGenerator you should use when developing for the Ext JS framework for WebsydianExpress.

The function inherits from PageGeneratorForProcess and has the same basic functionality, with a couple of important additions.

Usage

Apart from the ability to acts as a parent or a child, the main differences are in the template generation. It is important to note that there is no difference in the way you will use the PageGenerators compared with the standard PageGenerator functions.

You can include the function as a child on another page by adding a "FNC includes FNC" or "FNC comprises FNC" triple. The framework will keep track of whether the page is a top page or whether it is included on another page and control the output based on the situation.

Options (source codes)

All of the source codes described here only impacts the template generation - not the behavior of the PageGenerator when it is executed.

wsymetatemplatefolder

Default: wsystandardpage

This is the most important option you can specify for a PageGenerator. Technically, it specifies the top folder containing the meta templates that will be used when generating the templates for this PageGenerator. The standard value will use the default meta templates that is provided as part of the Websydian installation.

You can define your own meta templates, and use this property to specify the top folder of these meta templates. This folder must contain one or more files named MAIN.*; these files will be used as the starting point of the template generation.

The default installation supports the following values:

In general, you should not change this value yourself, instead inherit from the special abstract functions that supports these options.

wsypagetitle

In this source code you can specify a text that will be the page title of the generated page.

wsyproperties

Default: {}

The wsyproperties source code allows you to define any set of property names / values for the config object of the page.

You must specify a valid json object in the source code - including the curly brackets.

Note that the properties you define here are applied after the config object initially is created. This means that any properties you define here will override their default values - or the values defined in the other source codes scoped by the PageGenerator.

Special considerations

Avoid including the page as child page

In some cases, you might want to scope a PageGenerator by another PageGenerator without including it as a child page. You can do this by setting a function option for the scoped function:

Source Object Verb Target Object
MyPageGenerator FNC option NME

...value SYS

 WSYBASE/DoNotIncludeAsChild

Yes

If you do so, the _CreateTemplates function of the scoping page will not add the scoped page as a child.

Scoped _DocumentTemplateGenerator

The "normal" _DocumentTemplateGenerator function is set to implement No - you should never need to use this function - instead, always use the new _CreateTemplates function to generate the files needed for the Ext JS framework for WebsydianExpress.

More information